Schedule Reports by Event
Schedule Reports by Event is used When the user wants to schedule their event, after some event is fired. When you want to schedule your merge reports based on the trigger of an event, then the event schedule comes into the picture.
By using this document user will learn how to schedule merger report using event scheduling.
Objective
- Schedule Report using Event Scheduling
Prerequisites
- For this example Demo Merge Report used.
Download merge_report.zip file from link given merge_report.zip
- Upload Demo Merge Report.merge report from downloaded zip file to Merge Report Section. Refer this link to see how to upload files in OPNBI. Use same procedure to upload both of the files.
Steps for Event Scheduling
We will be using Demo Merge Report.merge in this example section for understanding.
There are two ways in which user can schedule the report.
I. By right-clicking on desired report & select Edit from the context menu.
II. By double clicking on desired report.
By opening the Merge Report, from one of the methods mentioned above user will see the window as below:
Go to Schedule tab & selct Event from the drop-down of Schedule Type as shown below:
Trigger Events define events on the trigger of which report will be scheduled.
Currently, event 1.1 has been created for this example as shown:
you can create an event of your own by clicking on which will open the following dialog box.
Here we have created an event numbered 5 which is an event related to Report as mentioned in Event Type & you can provide an optional description of the event as given below:
- Event Number: 5
- Event Type: Event Report
- Event Description: Event is triggered when report is generated
You can also send an email to different users when an event is fired.
For this check on event mail and enter the following details:
- Enter Users or Roles from the drop-down.
- Enter the email address of the user to who you want to send the email
- Select the template from the drop-down, Default for our case, and hit the Submit button.
As user clicks on submit button, one pop-up message will be shown displaying Event Created Successfully at the top - center of the screen.
If you want some external event to fire click on the which will guide you regarding necessary steps to perform the same.
Now you have successfully created an event, which is Event Number: 5. That will be visible in the dropdown of Trigger On Events in the Schedule tab.
We will use predefined event 1.1 for our example, so select event 1.1.
Click on Share in case you want to share the report with other users or user roles & here the Visibility is kept Internal for this example.
If you want your report to be approved before sending it to other users, then check Approval Require.
You can also specify how many times the report should be re-executed in case of failure and the interval from the drop-down menu shown in the figure. For instance, in our case, the report will be executed twice in case of failure within 5 minutes.
To specify the output, go to the output tab as follows:-
Enter the name by which you want to schedule the report in the Name text area. Also provide a suffix if required, it is optional.
Select the format in which you want to generate the output from the drop-down menu. We have selected pdf for our example.
You can also specify an event of the success/failure of the report, which will trigger an event and execute all the waiting for event reports.
You can also specify the delivery path on your computer where the reports will be downloaded/ send email to other users as follows.
Select the users and the roles from the drop-down menu & enter your email address/addresses to which you want to send the report via email.
Select a template from the drop-down, we have selected the Default template for our example.
Click on or icon in order to schedule the report.
By clickin icon SAVE & MERGE and MERGE icon will redirect you to another window of the browser where user can see teh preview of the report.
In case of any further help, the user can click on the icon to access the OPNBIHUB help documents.
If the user is not satisfied and wants to cancel the schedule request, he can do this by clicking on the cancel button next to the merge icon or by clicking on button next to the icon.
The report is scheduled and you can check that in the Requests section Requests tab, go to Waiting for the event which shows where the report is waiting for the event to trigger.
Click here to know more in detail about request section. Request section displays all the reports that have been completed, running, waiting for events or scheduled. In case of report failure, the error is also displayed on this page.
You can trigger an event with another report as follows:-
Here we schedule a report named Event Trigger which will trigger event 1 when run successfully. After this event is triggered, our Merge report will be executed.
In this manner, you can schedule your merge reports based on the trigger of events.
To understand in detail about Time Scheduling, click on the following link:-